chore: cf.add, cf.addnx, cf.exists, cf.mexists, cf.reserve by kostasrim · Pull Request #548 · dragonflydb/documentation

kostasrim · 2026-07-16T08:58:38Z

Add docs for:

cf.add
cf.addnx
cf.exists
cf.mexists
cf.reserve

Signed-off-by: Kostas Kyrimis <kostas@dragonflydb.io>

vercel · 2026-07-16T08:58:44Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
documentation	Ready	Preview, Comment	Jul 16, 2026 8:59am

qodo-free-for-open-source-projects · 2026-07-16T08:59:44Z

PR Summary by Qodo

Document Cuckoo Filter commands (COMPACT/COUNT/DEL/INFO/INSERT/INSERTNX)

📝 Documentation 🕐 10-20 Minutes

AI Description

• Add documentation pages for additional Cuckoo Filter commands and usage examples.
• Update command compatibility matrix to mark newly supported CF commands.
• Refresh “See also” cross-links across CF docs to reflect the expanded command set.

Diagram

graph TD
  A["Docusaurus docs"] --> B["compatibility.md"] --> H["New CF command docs"]
  A --> C["cf.add.md"] --> H
  A --> D["cf.addnx.md"] --> H
  A --> E["cf.exists.md"] --> H
  A --> F["cf.mexists.md"] --> H
  A --> G["cf.reserve.md"] --> H

High-Level Assessment

The following are alternative approaches to this PR:

1. Auto-generate command docs from a command spec/source-of-truth

➕ Reduces drift between implementation and documentation
➕ Enforces consistent sections (syntax/return/errors/examples)
➕ Makes adding new commands cheaper and less error-prone
➖ Requires building/maintaining a generator pipeline
➖ May be harder to include nuanced explanations and curated examples
➖ Up-front migration cost for existing docs

2. Centralize “See also” blocks via shared includes/partials

➕ Avoids manual link maintenance across many CF pages
➕ Improves consistency of cross-references as commands expand
➖ Adds indirection in markdown that can hinder quick edits
➖ May be limited by the docs toolchain’s include capabilities

Recommendation: The current manual docs additions are appropriate for quickly documenting newly supported CF commands. If the CF command surface continues to grow, consider introducing either doc generation from a command registry or at least shared partials for cross-link sections to reduce future maintenance and link drift.

Files changed (12) +351 / -7

Documentation (12) +351 / -7

compatibility.mdMark additional Cuckoo Filter commands as supported +3/-2

Mark additional Cuckoo Filter commands as supported
• Adds CF.COMPACT as fully supported and flips CF.INSERT/CF.INSERTNX from unsupported to fully supported in the compatibility matrix.
docs/command-reference/compatibility.md

cf.add.mdUpdate CF.ADD cross-references to include CF.INSERT +1/-1

Update CF.ADD cross-references to include CF.INSERT
• Extends the “See also” section to link to CF.INSERT alongside existing CF.ADDNX/CF.EXISTS/CF.RESERVE references.
docs/command-reference/cuckoo-filter/cf.add.md

cf.addnx.mdUpdate CF.ADDNX cross-references to include CF.INSERTNX +1/-1

Update CF.ADDNX cross-references to include CF.INSERTNX
• Extends the “See also” section to link to CF.INSERTNX, aligning navigation with the expanded command set.
docs/command-reference/cuckoo-filter/cf.addnx.md

cf.compact.mdAdd CF.COMPACT command documentation +52/-0

Add CF.COMPACT command documentation
• Introduces a new page describing CF.COMPACT, its purpose (sub-filter consolidation), complexity, return values, and example usage.
docs/command-reference/cuckoo-filter/cf.compact.md

cf.count.mdAdd CF.COUNT command documentation +50/-0

Add CF.COUNT command documentation
• Introduces a new page for CF.COUNT, explaining duplicate insertions, potential false positives, return values, and examples including missing-key behavior.
docs/command-reference/cuckoo-filter/cf.count.md

cf.del.mdAdd CF.DEL command documentation +56/-0

Add CF.DEL command documentation
• Introduces a new page for CF.DEL, covering single-occurrence deletion semantics, risks of false negatives from over-deletion, errors, and examples.
docs/command-reference/cuckoo-filter/cf.del.md

cf.exists.mdUpdate CF.EXISTS cross-references to include CF.COUNT +1/-1

Update CF.EXISTS cross-references to include CF.COUNT
• Expands the “See also” section to reference CF.COUNT in addition to CF.MEXISTS/CF.ADD/CF.RESERVE.
docs/command-reference/cuckoo-filter/cf.exists.md

cf.info.mdAdd CF.INFO command documentation +68/-0

Add CF.INFO command documentation
• Introduces a new page describing CF.INFO output fields (size, buckets, filters, inserted/deleted items, configuration) and example output formatting.
docs/command-reference/cuckoo-filter/cf.info.md

cf.insert.mdAdd CF.INSERT command documentation +59/-0

Add CF.INSERT command documentation
• Introduces a new page for CF.INSERT, documenting CAPACITY/NOCREATE options, multi-item insertion behavior, return codes, and example invocations.
docs/command-reference/cuckoo-filter/cf.insert.md

cf.insertnx.mdAdd CF.INSERTNX command documentation +58/-0

Add CF.INSERTNX command documentation
• Introduces a new page for CF.INSERTNX, documenting multi-item insertion with de-duplication semantics and return codes (1/0/-1) with examples.
docs/command-reference/cuckoo-filter/cf.insertnx.md

cf.mexists.mdUpdate CF.MEXISTS cross-references to include CF.INSERT +1/-1

Update CF.MEXISTS cross-references to include CF.INSERT
• Expands the “See also” section to include CF.INSERT, improving navigation between existence checks and multi-item inserts.
docs/command-reference/cuckoo-filter/cf.mexists.md

cf.reserve.mdUpdate CF.RESERVE cross-references to include CF.INSERT and CF.INFO +1/-1

Update CF.RESERVE cross-references to include CF.INSERT and CF.INFO
• Extends the “See also” section to include CF.INSERT and CF.INFO, tying filter creation/configuration to insertion and introspection commands.
docs/command-reference/cuckoo-filter/cf.reserve.md

qodo-free-for-open-source-projects · 2026-07-16T09:01:22Z

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

chore: cf.add, cf.addnx, cf.exists, cf.mexists, cf.reserve

86e8ca2

Signed-off-by: Kostas Kyrimis <kostas@dragonflydb.io>

kostasrim self-assigned this Jul 16, 2026

vercel Bot deployed to Preview July 16, 2026 08:59 View deployment

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

chore: cf.add, cf.addnx, cf.exists, cf.mexists, cf.reserve#548

chore: cf.add, cf.addnx, cf.exists, cf.mexists, cf.reserve#548
kostasrim wants to merge 1 commit into
kcuckoo3from
kcuckoo4

kostasrim commented Jul 16, 2026 •

edited

Loading

Uh oh!

vercel Bot commented Jul 16, 2026 •

edited

Loading

Uh oh!

qodo-free-for-open-source-projects Bot commented Jul 16, 2026

Uh oh!

qodo-free-for-open-source-projects Bot commented Jul 16, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Conversation

kostasrim commented Jul 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vercel Bot commented Jul 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

qodo-free-for-open-source-projects Bot commented Jul 16, 2026

PR Summary by Qodo

Uh oh!

qodo-free-for-open-source-projects Bot commented Jul 16, 2026

Code Review by Qodo

Great, no issues found!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

kostasrim commented Jul 16, 2026 •

edited

Loading

vercel Bot commented Jul 16, 2026 •

edited

Loading